<!DOCTYPE html>


<html lang="en">
<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Phaser CE Class: ScaleManager</title>
	<link rel="stylesheet" href="styles/site.phaser.css?2018062611">
</head>

<body>


<div class="navbar navbar-default navbar-fixed-top navbar-inverse">
  <div class="container-fluid">
  	<div class="navbar-header">
  		<a class="navbar-brand" href="index.html">Phaser CE</a>
  		<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
  			<span class="icon-bar"></span>
  			<span class="icon-bar"></span>
  			<span class="icon-bar"></span>
      </button>
  	</div>
  	<div class="navbar-collapse collapse" id="topNavigation">
  		<ul class="nav navbar-nav">
  			
  			<li class="dropdown">
  				<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
  				<ul class="dropdown-menu ">
  					<li><a href="Phaser.html">Phaser</a></li><li><a href="PhaserGlobal.html">PhaserGlobal</a></li><li><a href="PIXI.html">PIXI</a></li>
  				</ul>
  			</li>
  			
  			<li class="dropdown">
  				<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
  				<ul class="dropdown-menu ">
  					<li><a href="CreatureShader.html">CreatureShader</a></li><li><a href="EarCut.html">EarCut</a></li><li><a href="Event.html">Event</a></li><li><a href="EventTarget.html">EventTarget</a></li><li><a href="Phaser.Animation.html">Phaser.Animation</a></li><li><a href="Phaser.AnimationManager.html">Phaser.AnimationManager</a></li><li><a href="Phaser.AnimationParser.html">Phaser.AnimationParser</a></li><li><a href="Phaser.ArraySet.html">Phaser.ArraySet</a></li><li><a href="Phaser.ArrayUtils.html">Phaser.ArrayUtils</a></li><li><a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a></li><li><a href="Phaser.BitmapData.html">Phaser.BitmapData</a></li><li><a href="Phaser.BitmapText.html">Phaser.BitmapText</a></li><li><a href="Phaser.Bullet.html">Phaser.Bullet</a></li><li><a href="Phaser.Button.html">Phaser.Button</a></li><li><a href="Phaser.Cache.html">Phaser.Cache</a></li><li><a href="Phaser.Camera.html">Phaser.Camera</a></li><li><a href="Phaser.Canvas.html">Phaser.Canvas</a></li><li><a href="Phaser.CanvasPool.html">Phaser.CanvasPool</a></li><li><a href="Phaser.Circle.html">Phaser.Circle</a></li><li><a href="Phaser.Color.html">Phaser.Color</a></li><li><a href="Phaser.Component.Angle.html">Phaser.Component.Angle</a></li><li><a href="Phaser.Component.Animation.html">Phaser.Component.Animation</a></li><li><a href="Phaser.Component.AutoCull.html">Phaser.Component.AutoCull</a></li><li><a href="Phaser.Component.Bounds.html">Phaser.Component.Bounds</a></li><li><a href="Phaser.Component.BringToTop.html">Phaser.Component.BringToTop</a></li><li><a href="Phaser.Component.Core.html">Phaser.Component.Core</a></li><li><a href="Phaser.Component.Crop.html">Phaser.Component.Crop</a></li><li><a href="Phaser.Component.Delta.html">Phaser.Component.Delta</a></li><li><a href="Phaser.Component.Destroy.html">Phaser.Component.Destroy</a></li><li><a href="Phaser.Component.FixedToCamera.html">Phaser.Component.FixedToCamera</a></li><li><a href="Phaser.Component.Health.html">Phaser.Component.Health</a></li><li><a href="Phaser.Component.InCamera.html">Phaser.Component.InCamera</a></li><li><a href="Phaser.Component.InputEnabled.html">Phaser.Component.InputEnabled</a></li><li><a href="Phaser.Component.InWorld.html">Phaser.Component.InWorld</a></li><li><a href="Phaser.Component.LifeSpan.html">Phaser.Component.LifeSpan</a></li><li><a href="Phaser.Component.LoadTexture.html">Phaser.Component.LoadTexture</a></li><li><a href="Phaser.Component.Overlap.html">Phaser.Component.Overlap</a></li><li><a href="Phaser.Component.PhysicsBody.html">Phaser.Component.PhysicsBody</a></li><li><a href="Phaser.Component.Reset.html">Phaser.Component.Reset</a></li><li><a href="Phaser.Component.ScaleMinMax.html">Phaser.Component.ScaleMinMax</a></li><li><a href="Phaser.Component.Smoothed.html">Phaser.Component.Smoothed</a></li><li><a href="Phaser.Create.html">Phaser.Create</a></li><li><a href="Phaser.Creature.html">Phaser.Creature</a></li><li><a href="Phaser.Device.html">Phaser.Device</a></li><li><a href="Phaser.DeviceButton.html">Phaser.DeviceButton</a></li><li><a href="Phaser.DOM.html">Phaser.DOM</a></li><li><a href="Phaser.Easing.html">Phaser.Easing</a></li><li><a href="Phaser.Easing.Back.html">Phaser.Easing.Back</a></li><li><a href="Phaser.Easing.Bounce.html">Phaser.Easing.Bounce</a></li><li><a href="Phaser.Easing.Circular.html">Phaser.Easing.Circular</a></li><li><a href="Phaser.Easing.Cubic.html">Phaser.Easing.Cubic</a></li><li><a href="Phaser.Easing.Elastic.html">Phaser.Easing.Elastic</a></li><li><a href="Phaser.Easing.Exponential.html">Phaser.Easing.Exponential</a></li><li><a href="Phaser.Easing.Linear.html">Phaser.Easing.Linear</a></li><li><a href="Phaser.Easing.Quadratic.html">Phaser.Easing.Quadratic</a></li><li><a href="Phaser.Easing.Quartic.html">Phaser.Easing.Quartic</a></li><li><a href="Phaser.Easing.Quintic.html">Phaser.Easing.Quintic</a></li><li><a href="Phaser.Easing.Sinusoidal.html">Phaser.Easing.Sinusoidal</a></li><li><a href="Phaser.Ellipse.html">Phaser.Ellipse</a></li><li><a href="Phaser.Events.html">Phaser.Events</a></li><li><a href="Phaser.Filter.html">Phaser.Filter</a></li><li><a href="Phaser.FlexGrid.html">Phaser.FlexGrid</a></li><li><a href="Phaser.FlexLayer.html">Phaser.FlexLayer</a></li><li><a href="Phaser.Frame.html">Phaser.Frame</a></li><li><a href="Phaser.FrameData.html">Phaser.FrameData</a></li><li><a href="Phaser.Game.html">Phaser.Game</a></li><li><a href="Phaser.GameObjectCreator.html">Phaser.GameObjectCreator</a></li><li><a href="Phaser.GameObjectFactory.html">Phaser.GameObjectFactory</a></li><li><a href="Phaser.Gamepad.html">Phaser.Gamepad</a></li><li><a href="Phaser.Graphics.html">Phaser.Graphics</a></li><li><a href="Phaser.Group.html">Phaser.Group</a></li><li><a href="Phaser.Hermite.html">Phaser.Hermite</a></li><li><a href="Phaser.Image.html">Phaser.Image</a></li><li><a href="Phaser.ImageCollection.html">Phaser.ImageCollection</a></li><li><a href="Phaser.Input.html">Phaser.Input</a></li><li><a href="Phaser.InputHandler.html">Phaser.InputHandler</a></li><li><a href="Phaser.Key.html">Phaser.Key</a></li><li><a href="Phaser.Keyboard.html">Phaser.Keyboard</a></li><li><a href="Phaser.KeyCode.html">Phaser.KeyCode</a></li><li><a href="Phaser.Line.html">Phaser.Line</a></li><li><a href="Phaser.LinkedList.html">Phaser.LinkedList</a></li><li><a href="Phaser.Loader.html">Phaser.Loader</a></li><li><a href="Phaser.LoaderParser.html">Phaser.LoaderParser</a></li><li><a href="Phaser.Math.html">Phaser.Math</a></li><li><a href="Phaser.Matrix.html">Phaser.Matrix</a></li><li><a href="Phaser.Mouse.html">Phaser.Mouse</a></li><li><a href="Phaser.MouseWheel.html">Phaser.MouseWheel</a></li><li><a href="Phaser.MSPointer.html">Phaser.MSPointer</a></li><li><a href="Phaser.Net.html">Phaser.Net</a></li><li><a href="Phaser.Particle.html">Phaser.Particle</a></li><li><a href="Phaser.Particles.html">Phaser.Particles</a></li><li><a href="Phaser.Particles.Arcade.html">Phaser.Particles.Arcade</a></li><li><a href="Phaser.Particles.Arcade.Emitter.html">Phaser.Particles.Arcade.Emitter</a></li><li><a href="Phaser.Path.html">Phaser.Path</a></li><li><a href="Phaser.PathFollower.html">Phaser.PathFollower</a></li><li><a href="Phaser.PathPoint.html">Phaser.PathPoint</a></li><li><a href="Phaser.Physics.html">Phaser.Physics</a></li><li><a href="Phaser.Physics.Arcade.html">Phaser.Physics.Arcade</a></li><li><a href="Phaser.Physics.Arcade.Body.html">Phaser.Physics.Arcade.Body</a></li><li><a href="Phaser.Physics.Arcade.TilemapCollision.html">Phaser.Physics.Arcade.TilemapCollision</a></li><li><a href="Phaser.Physics.Ninja.html">Phaser.Physics.Ninja</a></li><li><a href="Phaser.Physics.Ninja.AABB.html">Phaser.Physics.Ninja.AABB</a></li><li><a href="Phaser.Physics.Ninja.Body.html">Phaser.Physics.Ninja.Body</a></li><li><a href="Phaser.Physics.Ninja.Circle.html">Phaser.Physics.Ninja.Circle</a></li><li><a href="Phaser.Physics.Ninja.Tile.html">Phaser.Physics.Ninja.Tile</a></li><li><a href="Phaser.Physics.P2.html">Phaser.Physics.P2</a></li><li><a href="Phaser.Physics.P2.Body.html">Phaser.Physics.P2.Body</a></li><li><a href="Phaser.Physics.P2.BodyDebug.html">Phaser.Physics.P2.BodyDebug</a></li><li><a href="Phaser.Physics.P2.CollisionGroup.html">Phaser.Physics.P2.CollisionGroup</a></li><li><a href="Phaser.Physics.P2.ContactMaterial.html">Phaser.Physics.P2.ContactMaterial</a></li><li><a href="Phaser.Physics.P2.DistanceConstraint.html">Phaser.Physics.P2.DistanceConstraint</a></li><li><a href="Phaser.Physics.P2.FixtureList.html">Phaser.Physics.P2.FixtureList</a></li><li><a href="Phaser.Physics.P2.GearConstraint.html">Phaser.Physics.P2.GearConstraint</a></li><li><a href="Phaser.Physics.P2.InversePointProxy.html">Phaser.Physics.P2.InversePointProxy</a></li><li><a href="Phaser.Physics.P2.LockConstraint.html">Phaser.Physics.P2.LockConstraint</a></li><li><a href="Phaser.Physics.P2.Material.html">Phaser.Physics.P2.Material</a></li><li><a href="Phaser.Physics.P2.PointProxy.html">Phaser.Physics.P2.PointProxy</a></li><li><a href="Phaser.Physics.P2.PrismaticConstraint.html">Phaser.Physics.P2.PrismaticConstraint</a></li><li><a href="Phaser.Physics.P2.RevoluteConstraint.html">Phaser.Physics.P2.RevoluteConstraint</a></li><li><a href="Phaser.Physics.P2.RotationalSpring.html">Phaser.Physics.P2.RotationalSpring</a></li><li><a href="Phaser.Physics.P2.Spring.html">Phaser.Physics.P2.Spring</a></li><li><a href="Phaser.Plugin.html">Phaser.Plugin</a></li><li><a href="Phaser.Plugin.PathManager.html">Phaser.Plugin.PathManager</a></li><li><a href="Phaser.PluginManager.html">Phaser.PluginManager</a></li><li><a href="Phaser.Point.html">Phaser.Point</a></li><li><a href="Phaser.Pointer.html">Phaser.Pointer</a></li><li><a href="Phaser.PointerLock.html">Phaser.PointerLock</a></li><li><a href="Phaser.PointerMode.html">Phaser.PointerMode</a></li><li><a href="Phaser.Polygon.html">Phaser.Polygon</a></li><li><a href="Phaser.QuadTree.html">Phaser.QuadTree</a></li><li><a href="Phaser.RandomDataGenerator.html">Phaser.RandomDataGenerator</a></li><li><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></li><li><a href="Phaser.RenderTexture.html">Phaser.RenderTexture</a></li><li><a href="Phaser.RequestAnimationFrame.html">Phaser.RequestAnimationFrame</a></li><li><a href="Phaser.RetroFont.html">Phaser.RetroFont</a></li><li><a href="Phaser.Rope.html">Phaser.Rope</a></li><li><a href="Phaser.RoundedRectangle.html">Phaser.RoundedRectangle</a></li><li><a href="Phaser.ScaleManager.html">Phaser.ScaleManager</a></li><li><a href="Phaser.Signal.html">Phaser.Signal</a></li><li><a href="Phaser.SignalBinding_.html">Phaser.SignalBinding</a></li><li><a href="Phaser.SinglePad.html">Phaser.SinglePad</a></li><li><a href="Phaser.Sound.html">Phaser.Sound</a></li><li><a href="Phaser.SoundManager.html">Phaser.SoundManager</a></li><li><a href="Phaser.Sprite.html">Phaser.Sprite</a></li><li><a href="Phaser.SpriteBatch.html">Phaser.SpriteBatch</a></li><li><a href="Phaser.Stage.html">Phaser.Stage</a></li><li><a href="Phaser.State.html">Phaser.State</a></li><li><a href="Phaser.StateManager.html">Phaser.StateManager</a></li><li><a href="Phaser.Text.html">Phaser.Text</a></li><li><a href="Phaser.Tile.html">Phaser.Tile</a></li><li><a href="Phaser.Tilemap.html">Phaser.Tilemap</a></li><li><a href="Phaser.TilemapLayer.html">Phaser.TilemapLayer</a></li><li><a href="Phaser.TilemapParser.html">Phaser.TilemapParser</a></li><li><a href="Phaser.Tileset.html">Phaser.Tileset</a></li><li><a href="Phaser.TileSprite.html">Phaser.TileSprite</a></li><li><a href="Phaser.Time.html">Phaser.Time</a></li><li><a href="Phaser.Timer.html">Phaser.Timer</a></li><li><a href="Phaser.TimerEvent.html">Phaser.TimerEvent</a></li><li><a href="Phaser.Touch.html">Phaser.Touch</a></li><li><a href="Phaser.Tween.html">Phaser.Tween</a></li><li><a href="Phaser.TweenData.html">Phaser.TweenData</a></li><li><a href="Phaser.TweenManager.html">Phaser.TweenManager</a></li><li><a href="Phaser.Utils.html">Phaser.Utils</a></li><li><a href="Phaser.Utils.Debug.html">Phaser.Utils.Debug</a></li><li><a href="Phaser.Video.html">Phaser.Video</a></li><li><a href="Phaser.Weapon.html">Phaser.Weapon</a></li><li><a href="Phaser.World.html">Phaser.World</a></li><li><a href="PIXI.BaseTexture.html">PIXI.BaseTexture</a></li><li><a href="PIXI.CanvasBuffer.html">PIXI.CanvasBuffer</a></li><li><a href="PIXI.CanvasGraphics.html">PIXI.CanvasGraphics</a></li><li><a href="PIXI.CanvasMaskManager.html">PIXI.CanvasMaskManager</a></li><li><a href="PIXI.CanvasRenderer.html">PIXI.CanvasRenderer</a></li><li><a href="PIXI.CanvasTinter.html">PIXI.CanvasTinter</a></li><li><a href="PIXI.ComplexPrimitiveShader.html">PIXI.ComplexPrimitiveShader</a></li><li><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></li><li><a href="PIXI.DisplayObjectContainer.html">PIXI.DisplayObjectContainer</a></li><li><a href="PIXI.FilterTexture.html">PIXI.FilterTexture</a></li><li><a href="PIXI.Phaser.GraphicsData.html">PIXI.Phaser.GraphicsData</a></li><li><a href="PIXI.PixiFastShader.html">PIXI.PixiFastShader</a></li><li><a href="PIXI.PixiShader.html">PIXI.PixiShader</a></li><li><a href="PIXI.PrimitiveShader.html">PIXI.PrimitiveShader</a></li><li><a href="PIXI.Sprite.html">PIXI.Sprite</a></li><li><a href="PIXI.StripShader.html">PIXI.StripShader</a></li><li><a href="PIXI.Texture.html">PIXI.Texture</a></li><li><a href="PIXI.WebGLBlendModeManager.html">PIXI.WebGLBlendModeManager</a></li><li><a href="PIXI.WebGLFastSpriteBatch.html">PIXI.WebGLFastSpriteBatch</a></li><li><a href="PIXI.WebGLFilterManager.html">PIXI.WebGLFilterManager</a></li><li><a href="PIXI.WebGLRenderer.html">PIXI.WebGLRenderer</a></li>
  				</ul>
  			</li>
  			
  			<li class="dropdown">
  				<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
  				<ul class="dropdown-menu ">
  					<li><a href="global.html">Global</a></li>
  				</ul>
  			</li>
  			
        <li>
  <a href="https://github.com/photonstorm/phaser-ce/blob/master/README.md">
    <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
    README
  </a>
</li>

<li>
  <a href="https://github.com/photonstorm/phaser-ce/blob/master/CHANGELOG.md">
    <span class="glyphicon glyphicon-list" aria-hidden="true"></span>
    CHANGELOG
  </a>
</li>

<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
    <span class="glyphicon glyphicon-globe" aria-hidden="true"></span>
    Community
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu">
    <li>
      <a href="http://phaser.io">Phaser</a>
    </li>
    <li>
      <a href="https://github.com/photonstorm/phaser-ce">Phaser CE on GitHub</a>
    </li>
    <li>
      <a href="https://codepen.io/collection/AMbZgY/">Phaser CE Examples</a>
    </li>
    <li>
      <a href="http://www.html5gamedevs.com/forum/14-phaser/">Forum</a>
    </li>
    <li>
      <a href="https://twitter.com/photonstorm">Twitter</a>
    </li>
    <li>
      <a href="http://phaser.io/community/slack">Slack</a>
    </li>
    <li>
      <a href="http://phaser.io/community/donate">Donate</a>
    </li>
  </ul>
</li>

  		</ul>
          
  	</div>
  </div>
</div>


<div class="container-fluid" id="toc-content">
	<div class="row">
		
	  <div class="col-md-9 col-md-offset-3">
		
			<div id="main">

	<h1 class="page-title">Class: ScaleManager</h1>
<section>

<header>
    
        <h2>
            <span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
        
        ScaleManager
        </h2>
        
            <div class="class-description"><p>The ScaleManager object handles the the scaling, resizing, and alignment of the
Game size and the game Display canvas.</p>
<p>The Game size is the logical size of the game; the Display canvas has size as an HTML element.</p>
<p>The calculations of these are heavily influenced by the bounding Parent size which is the computed
dimensions of the Display canvas's Parent container/element - the <em>effective CSS rules of the
canvas's Parent element play an important role</em> in the operation of the ScaleManager.</p>
<p>The Display canvas - or Game size, depending <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a> - is updated to best utilize the Parent size.
When in Fullscreen mode or with <a href="Phaser.ScaleManager.html#parentIsWindow">parentIsWindow</a> the Parent size is that of the visual viewport (see <a href="Phaser.ScaleManager.html#getParentBounds">getParentBounds</a>).</p>
<h4>Parent and Display canvas containment guidelines:</h4><ul>
<li><p>Style the Parent element (of the game canvas) to control the Parent size and
thus the Display canvas's size and layout.</p>
</li>
<li><p>The Parent element's CSS styles should <em>effectively</em> apply maximum (and minimum) bounding behavior.</p>
</li>
<li><p>The Parent element should <em>not</em> apply a padding as this is not accounted for.
If a padding is required apply it to the Parent's parent or apply a margin to the Parent.
If you need to add a border, margin or any other CSS around your game container, then use a parent element and
apply the CSS to this instead, otherwise you'll be constantly resizing the shape of the game container.</p>
</li>
<li><p>The Display canvas layout CSS styles (i.e. margins, size) should not be altered/specified as
they may be updated by the ScaleManager.</p>
</li>
</ul>
<h4>Example Uses</h4><ul>
<li><h5>Fixed game size; scale canvas proportionally to fill its container</h5><p>Use <code>scaleMode</code> SHOW_ALL.</p>
</li>
<li><h5>Fixed game size; stretch canvas to fill its container (uncommon)</h5><p>Use <code>scaleMode</code> EXACT_FIT.</p>
</li>
<li><h5>Fixed game size; scale canvas proportionally by some other criteria</h5><p>Use <code>scaleMode</code> USER_SCALE. Examine <code>parentBounds</code> in the resize callback and call <a href="Phaser.ScaleManager.html#setUserScale">setUserScale</a> if necessary.</p>
</li>
<li><h5>Fluid game/canvas size</h5><p>Use <code>scaleMode</code> RESIZE. Examine the game or canvas size from the <a href="Phaser.ScaleManager.html#onSizeChange">onSizeChange</a> signal <strong>or</strong> the <a href="Phaser.State.html#resize">Phaser.State#resize</a> callback and reposition game objects if necessary.</p>
</li>
<li><h5>Preferred orientation</h5><p>Call <a href="Phaser.ScaleManager.html#forceOrientation">forceOrientation</a> with the preferred orientation and use any of the <a href="Phaser.ScaleManager.html#onOrientationChange">onOrientationChange</a>, <a href="Phaser.ScaleManager.html#enterIncorrectOrientation">enterIncorrectOrientation</a>, or <a href="Phaser.ScaleManager.html#leaveIncorrectOrientation">leaveIncorrectOrientation</a> signals.</p>
</li>
</ul></div>
        
    
</header>


<article>
    <div class="container-overview">
    
        
<dt>
    <h4 class="name" id="ScaleManager" data-name="ScaleManager">
      <span class="type-signature"></span>new ScaleManager(game, width, height)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Create a new ScaleManager object - this is done automatically by <a href="Phaser.Game.html">Phaser.Game</a></p>
<p>The <code>width</code> and <code>height</code> constructor parameters can either be a number which represents pixels or a string that represents a percentage: e.g. <code>800</code> (for 800 pixels) or <code>&quot;80%&quot;</code> for 80%.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>game</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>



            
            </td>

            

            

            <td class="description param-description last"><p>A reference to the currently running game.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>
|

<span class="param-type">string</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The width of the game. See above.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>
|

<span class="param-type">string</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The height of the game. See above.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L68" title="ScaleManager on line 68 of src/core/ScaleManager.js">src/core/ScaleManager.js line 68</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

    
    </div>

    

    

    

    

    

    
        <h3 class="subsection-title">Members</h3>

        <dl>
            
<dt>
    <h4 id=".EXACT_FIT" data-name="EXACT_FIT">
      <span class="type-signature">&lt;static, constant> </span>EXACT_FIT<span class="type-signature"> : integer</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A scale mode that stretches content to fill all available space - see <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">integer</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L636" title="EXACT_FIT on line 636 of src/core/ScaleManager.js">src/core/ScaleManager.js line 636</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id=".MODES" data-name="MODES">
      <span class="type-signature">&lt;static, constant> </span>MODES<span class="type-signature"> : Array.&lt;string></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Names of the scale modes, indexed by value.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Array.&lt;string></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L676" title="MODES on line 676 of src/core/ScaleManager.js">src/core/ScaleManager.js line 676</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id=".NO_SCALE" data-name="NO_SCALE">
      <span class="type-signature">&lt;static, constant> </span>NO_SCALE<span class="type-signature"> : integer</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A scale mode that prevents any scaling - see <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">integer</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L644" title="NO_SCALE on line 644 of src/core/ScaleManager.js">src/core/ScaleManager.js line 644</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id=".RESIZE" data-name="RESIZE">
      <span class="type-signature">&lt;static, constant> </span>RESIZE<span class="type-signature"> : integer</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A scale mode that causes the Game size to change - see <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">integer</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L660" title="RESIZE on line 660 of src/core/ScaleManager.js">src/core/ScaleManager.js line 660</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id=".SHOW_ALL" data-name="SHOW_ALL">
      <span class="type-signature">&lt;static, constant> </span>SHOW_ALL<span class="type-signature"> : integer</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A scale mode that shows the entire game while maintaining proportions - see <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">integer</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L652" title="SHOW_ALL on line 652 of src/core/ScaleManager.js">src/core/ScaleManager.js line 652</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id=".USER_SCALE" data-name="USER_SCALE">
      <span class="type-signature">&lt;static, constant> </span>USER_SCALE<span class="type-signature"> : integer</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A scale mode that allows a custom scale factor - see <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">integer</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L668" title="USER_SCALE on line 668 of src/core/ScaleManager.js">src/core/ScaleManager.js line 668</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="aspectRatio" data-name="aspectRatio">
      <span class="type-signature">&lt;readonly> </span>aspectRatio<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The aspect ratio of the scaled Display canvas.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L372" title="aspectRatio on line 372 of src/core/ScaleManager.js">src/core/ScaleManager.js line 372</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="boundingParent" data-name="boundingParent">
      <span class="type-signature">&lt;readonly> </span>boundingParent<span class="type-signature"> : DOMElement</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The DOM element that is considered the Parent bounding element, if any.</p>
<p>This <code>null</code> if <a href="Phaser.ScaleManager.html#parentIsWindow">parentIsWindow</a> is true or if fullscreen mode is entered and <a href="Phaser.ScaleManager.html#fullScreenTarget">fullScreenTarget</a> is specified.
It will also be null if there is no game canvas or if the game canvas has no parent.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">DOMElement</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L2238" title="boundingParent on line 2238 of src/core/ScaleManager.js">src/core/ScaleManager.js line 2238</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="bounds" data-name="bounds">
      <span class="type-signature">&lt;readonly> </span>bounds<span class="type-signature"> : <a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The bounds of the scaled game. The x/y will match the offset of the canvas element and the width/height the scaled width and height.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L365" title="bounds on line 365 of src/core/ScaleManager.js">src/core/ScaleManager.js line 365</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="compatibility" data-name="compatibility">
      <span class="type-signature">&lt;protected> </span>compatibility<span class="type-signature"></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Various compatibility settings.
A value of &quot;(auto)&quot; indicates the setting is configured based on device and runtime information.</p>
<p>A <a href="Phaser.ScaleManager.html#refresh">refresh</a> may need to be performed after making changes.</p>
    </div>
    

    

    
<dl class="details">
    

    <h5 class="subsection-title">Properties:</h5>

    <dl>

<table class="props table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>supportsFullScreen</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            
                <td class="default">
                
                    (auto)
                
                </td>
            

            <td class="description prop-description last"><p>True only if fullscreen support will be used. (Changing to fullscreen still might not work.)</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>orientationFallback</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            
                <td class="default">
                
                    (auto)
                
                </td>
            

            <td class="description prop-description last"><p>See <a href="Phaser.DOM.html#.getScreenOrientation">Phaser.DOM.getScreenOrientation</a>.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>noMargins</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description prop-description last"><p>If true then the Display canvas's margins will not be updated anymore: existing margins must be manually cleared. Disabling margins prevents automatic canvas alignment/centering, possibly in fullscreen.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>scrollTo</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                    &lt;nullable><br>
                
                </td>
            

            
                <td class="default">
                
                    (auto)
                
                </td>
            

            <td class="description prop-description last"><p>If specified the window will be scrolled to this position on every refresh.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>forceMinimumDocumentHeight</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description prop-description last"><p>If enabled the document elements minimum height is explicitly set on updates.
   The height set varies by device and may either be the height of the window or the viewport.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>canExpandParent</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description prop-description last"><p>If enabled then SHOW_ALL and USER_SCALE modes can try and expand the parent element. It may be necessary for the parent element to impose CSS width/height restrictions.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>clickTrampoline</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            
                <td class="default">
                
                    (auto)
                
                </td>
            

            <td class="description prop-description last"><p>On certain browsers (eg. IE) FullScreen events need to be triggered via 'click' events.
    A value of 'when-not-mouse' uses a click trampoline when a pointer that is not the primary mouse is used.
    Any other string value (including the empty string) prevents using click trampolines.
    For more details on click trampolines see <a href="Phaser.Pointer.html#addClickTrampoline">Phaser.Pointer#addClickTrampoline</a>.</p></td>
        </tr>

    
    </tbody>
</table>
</dl>

    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L433" title="compatibility on line 433 of src/core/ScaleManager.js">src/core/ScaleManager.js line 433</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="currentScaleMode" data-name="currentScaleMode">
      <span class="type-signature">&lt;protected, readonly> </span>currentScaleMode<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Returns the current scale mode - for normal or fullscreen operation.</p>
<p>See <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a> for the different modes allowed.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L2376" title="currentScaleMode on line 2376 of src/core/ScaleManager.js">src/core/ScaleManager.js line 2376</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="dom" data-name="dom">
      <span class="type-signature">&lt;protected, readonly> </span>dom<span class="type-signature"> : <a href="Phaser.DOM.html">Phaser.DOM</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Provides access to some cross-device DOM functions.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.DOM.html">Phaser.DOM</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L85" title="dom on line 85 of src/core/ScaleManager.js">src/core/ScaleManager.js line 85</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="enterIncorrectOrientation" data-name="enterIncorrectOrientation">
      <span class="type-signature"></span>enterIncorrectOrientation<span class="type-signature"> : <a href="Phaser.Signal.html">Phaser.Signal</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>This signal is dispatched when the browser enters an incorrect orientation, as defined by <a href="Phaser.ScaleManager.html#forceOrientation">forceOrientation</a>.</p>
<p>This is signaled from <code>preUpdate</code> (or <code>pauseUpdate</code>) <em>even when</em> the game is paused.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L234" title="enterIncorrectOrientation on line 234 of src/core/ScaleManager.js">src/core/ScaleManager.js line 234</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="forceLandscape" data-name="forceLandscape">
      <span class="type-signature">&lt;protected, readonly> </span>forceLandscape<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>If true, the game should only run in a landscape orientation.
Change with <a href="Phaser.ScaleManager.html#forceOrientation">forceOrientation</a>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L163" title="forceLandscape on line 163 of src/core/ScaleManager.js">src/core/ScaleManager.js line 163</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="forcePortrait" data-name="forcePortrait">
      <span class="type-signature">&lt;protected, readonly> </span>forcePortrait<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>If true, the game should only run in a portrait
Change with <a href="Phaser.ScaleManager.html#forceOrientation">forceOrientation</a>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L173" title="forcePortrait on line 173 of src/core/ScaleManager.js">src/core/ScaleManager.js line 173</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="fullScreenScaleMode" data-name="fullScreenScaleMode">
      <span class="type-signature"></span>fullScreenScaleMode<span class="type-signature"> : integer</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The scaling method used by the ScaleManager when in fullscreen.</p>
<p>See <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a> for the different modes allowed.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">integer</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L2333" title="fullScreenScaleMode on line 2333 of src/core/ScaleManager.js">src/core/ScaleManager.js line 2333</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="fullScreenTarget" data-name="fullScreenTarget">
      <span class="type-signature"></span>fullScreenTarget<span class="type-signature"> : DOMElement</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>If specified, this is the DOM element on which the Fullscreen API enter request will be invoked.
The target element must have the correct CSS styling and contain the Display canvas.</p>
<p>The elements style will be modified (ie. the width and height might be set to 100%)
but it will not be added to, removed from, or repositioned within the DOM.
An attempt is made to restore relevant style changes when fullscreen mode is left.</p>
<p>For pre-2.2.0 behavior set <code>game.scale.fullScreenTarget = game.canvas</code>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">DOMElement</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L271" title="fullScreenTarget on line 271 of src/core/ScaleManager.js">src/core/ScaleManager.js line 271</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="game" data-name="game">
      <span class="type-signature">&lt;protected, readonly> </span>game<span class="type-signature"> : <a href="Phaser.Game.html">Phaser.Game</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A reference to the currently running game.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L77" title="game on line 77 of src/core/ScaleManager.js">src/core/ScaleManager.js line 77</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="grid" data-name="grid">
      <span class="type-signature"></span>grid<span class="type-signature"> : <a href="Phaser.FlexGrid.html">Phaser.FlexGrid</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p><em>EXPERIMENTAL:</em> A responsive grid on which you can align game objects.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.FlexGrid.html">Phaser.FlexGrid</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L92" title="grid on line 92 of src/core/ScaleManager.js">src/core/ScaleManager.js line 92</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="hasPhaserSetFullScreen" data-name="hasPhaserSetFullScreen">
      <span class="type-signature"></span>hasPhaserSetFullScreen<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>This boolean provides you with a way to determine if the browser is in Full Screen
mode (via the Full Screen API), and Phaser was the one responsible for activating it.</p>
<p>It's possible that ScaleManager.isFullScreen returns <code>true</code> even if Phaser wasn't the
one that made the browser go full-screen, so this flag lets you determine that.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L256" title="hasPhaserSetFullScreen on line 256 of src/core/ScaleManager.js">src/core/ScaleManager.js line 256</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="height" data-name="height">
      <span class="type-signature">&lt;readonly> </span>height<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Target height (in pixels) of the Display canvas.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L106" title="height on line 106 of src/core/ScaleManager.js">src/core/ScaleManager.js line 106</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="incorrectOrientation" data-name="incorrectOrientation">
      <span class="type-signature">&lt;protected, readonly> </span>incorrectOrientation<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>True if <a href="Phaser.ScaleManager.html#forceLandscape">forceLandscape</a> or <a href="Phaser.ScaleManager.html#forcePortrait">forcePortrait</a> are set and do not agree with the browser orientation.</p>
<p>This value is not updated immediately.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L184" title="incorrectOrientation on line 184 of src/core/ScaleManager.js">src/core/ScaleManager.js line 184</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="isFullScreen" data-name="isFullScreen">
      <span class="type-signature">&lt;readonly> </span>isFullScreen<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Returns true if the browser is in fullscreen mode, otherwise false.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L2472" title="isFullScreen on line 2472 of src/core/ScaleManager.js">src/core/ScaleManager.js line 2472</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="isGameLandscape" data-name="isGameLandscape">
      <span class="type-signature">&lt;readonly> </span>isGameLandscape<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Returns true if the game dimensions are landscape (width &gt; height).
This is especially useful to check when using the RESIZE scale mode
but wanting to maintain game orientation on desktop browsers,
where typically the screen orientation will always be landscape regardless of the browser viewport.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L2541" title="isGameLandscape on line 2541 of src/core/ScaleManager.js">src/core/ScaleManager.js line 2541</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="isGamePortrait" data-name="isGamePortrait">
      <span class="type-signature">&lt;readonly> </span>isGamePortrait<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Returns true if the game dimensions are portrait (height &gt; width).
This is especially useful to check when using the RESIZE scale mode
but wanting to maintain game orientation on desktop browsers,
where typically the screen orientation will always be landscape regardless of the browser viewport.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L2522" title="isGamePortrait on line 2522 of src/core/ScaleManager.js">src/core/ScaleManager.js line 2522</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="isLandscape" data-name="isLandscape">
      <span class="type-signature">&lt;readonly> </span>isLandscape<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Returns true if the screen orientation is in landscape mode.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L2506" title="isLandscape on line 2506 of src/core/ScaleManager.js">src/core/ScaleManager.js line 2506</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="isPortrait" data-name="isPortrait">
      <span class="type-signature">&lt;readonly> </span>isPortrait<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Returns true if the screen orientation is in portrait mode.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L2490" title="isPortrait on line 2490 of src/core/ScaleManager.js">src/core/ScaleManager.js line 2490</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="leaveIncorrectOrientation" data-name="leaveIncorrectOrientation">
      <span class="type-signature"></span>leaveIncorrectOrientation<span class="type-signature"> : <a href="Phaser.Signal.html">Phaser.Signal</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>This signal is dispatched when the browser leaves an incorrect orientation, as defined by <a href="Phaser.ScaleManager.html#forceOrientation">forceOrientation</a>.</p>
<p>This is signaled from <code>preUpdate</code> (or <code>pauseUpdate</code>) <em>even when</em> the game is paused.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L244" title="leaveIncorrectOrientation on line 244 of src/core/ScaleManager.js">src/core/ScaleManager.js line 244</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="margin" data-name="margin">
      <span class="type-signature">&lt;protected, readonly> </span>margin<span class="type-signature"> : Bounds-like</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Display canvas is aligned by adjusting the margins; the last margins are stored here.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Bounds-like</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L358" title="margin on line 358 of src/core/ScaleManager.js">src/core/ScaleManager.js line 358</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="maxHeight" data-name="maxHeight">
      <span class="type-signature">&lt;protected, readonly> </span>maxHeight<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Maximum height the canvas should be scaled to (in pixels).
If null it will scale to whatever height the browser can handle.
Change with <a href="Phaser.ScaleManager.html#setMinMax">setMinMax</a>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L144" title="maxHeight on line 144 of src/core/ScaleManager.js">src/core/ScaleManager.js line 144</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="maxWidth" data-name="maxWidth">
      <span class="type-signature">&lt;protected, readonly> </span>maxWidth<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Maximum width the canvas should be scaled to (in pixels).
If null it will scale to whatever width the browser can handle.
Change with <a href="Phaser.ScaleManager.html#setMinMax">setMinMax</a>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L125" title="maxWidth on line 125 of src/core/ScaleManager.js">src/core/ScaleManager.js line 125</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="minHeight" data-name="minHeight">
      <span class="type-signature">&lt;protected, readonly> </span>minHeight<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Minimum height the canvas should be scaled to (in pixels).
Change with <a href="Phaser.ScaleManager.html#setMinMax">setMinMax</a>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L134" title="minHeight on line 134 of src/core/ScaleManager.js">src/core/ScaleManager.js line 134</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="minWidth" data-name="minWidth">
      <span class="type-signature">&lt;protected, readonly> </span>minWidth<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Minimum width the canvas should be scaled to (in pixels).
Change with <a href="Phaser.ScaleManager.html#setMinMax">setMinMax</a>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L115" title="minWidth on line 115 of src/core/ScaleManager.js">src/core/ScaleManager.js line 115</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="offset" data-name="offset">
      <span class="type-signature">&lt;protected, readonly> </span>offset<span class="type-signature"> : <a href="Phaser.Point.html">Phaser.Point</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The offset coordinates of the Display canvas from the top-left of the browser window.
The is used internally by Phaser.Pointer (for Input) and possibly other types.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L153" title="offset on line 153 of src/core/ScaleManager.js">src/core/ScaleManager.js line 153</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onFullScreenChange" data-name="onFullScreenChange">
      <span class="type-signature"></span>onFullScreenChange<span class="type-signature"> : <a href="Phaser.Signal.html">Phaser.Signal</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>This signal is dispatched when the browser enters or leaves fullscreen mode, if supported.</p>
<p>The signal is supplied with a single argument: <code>scale</code> (the ScaleManager). Use <code>scale.isFullScreen</code> to determine
if currently running in Fullscreen mode.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L313" title="onFullScreenChange on line 313 of src/core/ScaleManager.js">src/core/ScaleManager.js line 313</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onFullScreenError" data-name="onFullScreenError">
      <span class="type-signature"></span>onFullScreenError<span class="type-signature"> : <a href="Phaser.Signal.html">Phaser.Signal</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>This signal is dispatched when the browser fails to enter fullscreen mode;
or if the device does not support fullscreen mode and <code>startFullScreen</code> is invoked.</p>
<p>The signal is supplied with a single argument: <code>scale</code> (the ScaleManager).</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L324" title="onFullScreenError on line 324 of src/core/ScaleManager.js">src/core/ScaleManager.js line 324</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onFullScreenInit" data-name="onFullScreenInit">
      <span class="type-signature"></span>onFullScreenInit<span class="type-signature"> : <a href="Phaser.Signal.html">Phaser.Signal</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>This signal is dispatched when fullscreen mode is ready to be initialized but
before the fullscreen request.</p>
<p>The signal is passed two arguments: <code>scale</code> (the ScaleManager), and an object in the form <code>{targetElement: DOMElement}</code>.</p>
<p>The <code>targetElement</code> is the <a href="Phaser.ScaleManager.html#fullScreenTarget">fullScreenTarget</a> element,
if such is assigned, or a new element created by <a href="Phaser.ScaleManager.html#createFullScreenTarget">createFullScreenTarget</a>.</p>
<p>Custom CSS styling or resets can be applied to <code>targetElement</code> as required.</p>
<p>If <code>targetElement</code> is <em>not</em> the same element as <a href="Phaser.ScaleManager.html#fullScreenTarget">fullScreenTarget</a>:</p>
<ul>
<li>After initialization the Display canvas is moved onto the <code>targetElement</code> for
the duration of the fullscreen mode, and restored to it's original DOM location when fullscreen is exited.</li>
<li>The <code>targetElement</code> is moved/re-parented within the DOM and may have its CSS styles updated.</li>
</ul>
<p>The behavior of a pre-assigned target element is covered in <a href="Phaser.ScaleManager.html#fullScreenTarget">fullScreenTarget</a>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L302" title="onFullScreenInit on line 302 of src/core/ScaleManager.js">src/core/ScaleManager.js line 302</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onOrientationChange" data-name="onOrientationChange">
      <span class="type-signature"></span>onOrientationChange<span class="type-signature"> : <a href="Phaser.Signal.html">Phaser.Signal</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>This signal is dispatched when the orientation changes <em>or</em> the validity of the current orientation changes.</p>
<p>The signal is supplied with the following arguments:</p>
<ul>
<li><code>scale</code> - the ScaleManager object</li>
<li><code>prevOrientation</code>, a string - The previous orientation as per <a href="Phaser.ScaleManager.html#screenOrientation">screenOrientation</a>.</li>
<li><code>wasIncorrect</code>, a boolean - True if the previous orientation was last determined to be incorrect.</li>
</ul>
<p>Access the current orientation and validity with <code>scale.screenOrientation</code> and <code>scale.incorrectOrientation</code>.
Thus the following tests can be done:</p>
<pre class="prettyprint source"><code>// The orientation itself changed:
scale.screenOrientation !== prevOrientation
// The orientation just became incorrect:
scale.incorrectOrientation && !wasIncorrect</code></pre><p>It is possible that this signal is triggered after <a href="Phaser.ScaleManager.html#forceOrientation">forceOrientation</a> so the orientation
correctness changes even if the orientation itself does not change.</p>
<p>This is signaled from <code>preUpdate</code> (or <code>pauseUpdate</code>) <em>even when</em> the game is paused.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L224" title="onOrientationChange on line 224 of src/core/ScaleManager.js">src/core/ScaleManager.js line 224</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onSizeChange" data-name="onSizeChange">
      <span class="type-signature"></span>onSizeChange<span class="type-signature"> : <a href="Phaser.Signal.html">Phaser.Signal</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>This signal is dispatched when the size of the Display canvas changes <em>or</em> the size of the Game changes.
When invoked this is done <em>after</em> the Canvas size/position have been updated.</p>
<p>The callback is supplied with three arguments: the Scale Manager, canvas <a href="Phaser.ScaleManager.html#width">width</a>, and canvas <a href="Phaser.ScaleManager.html#height">height</a>. (Game dimensions can be found in <code>scale.game.width</code> and <code>scale.game.height</code>.)</p>
<p>This signal is <em>only</em> called when a change occurs and a reflow may be required.
For example, if the canvas does not change sizes because of CSS settings (such as min-width)
then this signal will <em>not</em> be triggered.</p>
<p>Use this to handle responsive game layout options.</p>
<p>This is signaled from <code>preUpdate</code> (or <code>pauseUpdate</code>) <em>even when</em> the game is paused.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L514" title="onSizeChange on line 514 of src/core/ScaleManager.js">src/core/ScaleManager.js line 514</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="pageAlignHorizontally" data-name="pageAlignHorizontally">
      <span class="type-signature"></span>pageAlignHorizontally<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>When enabled the Display canvas will be horizontally-aligned <em>in the Parent container</em> (or <a href="Phaser.ScaleManager.html#parentIsWindow">window</a>).</p>
<p>To align horizontally across the page the Display canvas should be added directly to page;
or the parent container should itself be horizontally aligned.</p>
<p>Horizontal alignment is not applicable with the <a href="Phaser.ScaleManager.html#.RESIZE">RESIZE</a> scaling mode.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>false</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L2397" title="pageAlignHorizontally on line 2397 of src/core/ScaleManager.js">src/core/ScaleManager.js line 2397</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="pageAlignVertically" data-name="pageAlignVertically">
      <span class="type-signature"></span>pageAlignVertically<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>When enabled the Display canvas will be vertically-aligned <em>in the Parent container</em> (or <a href="Phaser.ScaleManager.html#parentIsWindow">window</a>).</p>
<p>To align vertically the Parent element should have a <em>non-collapsible</em> height, such that it will maintain
a height <em>larger</em> than the height of the contained Game canvas - the game canvas will then be scaled vertically
<em>within</em> the remaining available height dictated by the Parent element.</p>
<p>One way to prevent the parent from collapsing is to add an absolute &quot;min-height&quot; CSS property to the parent element.
If specifying a relative &quot;min-height/height&quot; or adjusting margins, the Parent height must still be non-collapsible (see note).</p>
<p><em>Note</em>: In version 2.2 the minimum document height is <em>not</em> automatically set to the viewport/window height.
To automatically update the minimum document height set <a href="Phaser.ScaleManager.html#compatibility">compatibility.forceMinimumDocumentHeight</a> to true.</p>
<p>Vertical alignment is not applicable with the <a href="Phaser.ScaleManager.html#.RESIZE">RESIZE</a> scaling mode.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>false</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L2431" title="pageAlignVertically on line 2431 of src/core/ScaleManager.js">src/core/ScaleManager.js line 2431</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="parentIsWindow" data-name="parentIsWindow">
      <span class="type-signature"></span>parentIsWindow<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>True if the the browser window (instead of the display canvas's DOM parent) should be used as the bounding parent.</p>
<p>This is set automatically based on the <code>parent</code> argument passed to <a href="Phaser.Game.html">Phaser.Game</a>.</p>
<p>The <a href="Phaser.ScaleManager.html#parentNode">parentNode</a> property is generally ignored while this is in effect.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L466" title="parentIsWindow on line 466 of src/core/ScaleManager.js">src/core/ScaleManager.js line 466</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="parentNode" data-name="parentNode">
      <span class="type-signature"></span>parentNode<span class="type-signature"> : DOMElement</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The <em>original</em> DOM element for the parent of the Display canvas.
This may be different in fullscreen - see <a href="Phaser.ScaleManager.html#createFullScreenTarget">createFullScreenTarget</a>.</p>
<p>This is set automatically based on the <code>parent</code> argument passed to <a href="Phaser.Game.html">Phaser.Game</a>.</p>
<p>This should only be changed after moving the Game canvas to a different DOM parent.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">DOMElement</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L478" title="parentNode on line 478 of src/core/ScaleManager.js">src/core/ScaleManager.js line 478</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="parentScaleFactor" data-name="parentScaleFactor">
      <span class="type-signature">&lt;readonly> </span>parentScaleFactor<span class="type-signature"> : <a href="Phaser.Point.html">Phaser.Point</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The scale of the game in relation to its parent container.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L485" title="parentScaleFactor on line 485 of src/core/ScaleManager.js">src/core/ScaleManager.js line 485</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="scaleFactor" data-name="scaleFactor">
      <span class="type-signature">&lt;readonly> </span>scaleFactor<span class="type-signature"> : <a href="Phaser.Point.html">Phaser.Point</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The <em>current</em> scale factor based on the game dimensions vs. the scaled dimensions.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L341" title="scaleFactor on line 341 of src/core/ScaleManager.js">src/core/ScaleManager.js line 341</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="scaleFactorInversed" data-name="scaleFactorInversed">
      <span class="type-signature">&lt;protected, readonly> </span>scaleFactorInversed<span class="type-signature"> : <a href="Phaser.Point.html">Phaser.Point</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The <em>current</em> inversed scale factor. The displayed dimensions divided by the game dimensions.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L349" title="scaleFactorInversed on line 349 of src/core/ScaleManager.js">src/core/ScaleManager.js line 349</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="scaleMode" data-name="scaleMode">
      <span class="type-signature"></span>scaleMode<span class="type-signature"> : integer</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The scaling method used by the ScaleManager when not in fullscreen.</p>
<dl>
  <dt><a href="Phaser.ScaleManager.html#.NO_SCALE">Phaser.ScaleManager.NO_SCALE</a></dt>
  <dd>
      The Game display area will not be scaled - even if it is too large for the canvas/screen.
      This mode <em>ignores</em> any applied scaling factor and displays the canvas at the Game size.
  </dd>
  <dt><a href="Phaser.ScaleManager.html#.EXACT_FIT">Phaser.ScaleManager.EXACT_FIT</a></dt>
  <dd>
      The Game display area will be <em>stretched</em> to fill the entire size of the canvas's parent element and/or screen.
      Proportions are not maintained.
  </dd>
  <dt><a href="Phaser.ScaleManager.html#.SHOW_ALL">Phaser.ScaleManager.SHOW_ALL</a></dt>
  <dd>
      Show the entire game display area while <em>maintaining</em> the original aspect ratio.
  </dd>
  <dt><a href="Phaser.ScaleManager.html#.RESIZE">Phaser.ScaleManager.RESIZE</a></dt>
  <dd>
      The dimensions of the game display area are changed to match the size of the parent container.
      That is, this mode <em>changes the Game size</em> to match the display size.
      <p>
      Any manually set Game size (see <a href="Phaser.ScaleManager.html#setGameSize">setGameSize</a>) is ignored while in effect.
  </dd>
  <dt><a href="Phaser.ScaleManager.html#.USER_SCALE">Phaser.ScaleManager.USER_SCALE</a></dt>
  <dd>
      The game Display is scaled according to the user-specified scale set by <a href="Phaser.ScaleManager.html#setUserScale">setUserScale</a>.
      <p>
      This scale can be adjusted in the <a href="Phaser.ScaleManager.html#setResizeCallback">resize callback</a>
      for flexible custom-sizing needs.
  </dd>
</dl>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">integer</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L2267" title="scaleMode on line 2267 of src/core/ScaleManager.js">src/core/ScaleManager.js line 2267</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="screenOrientation" data-name="screenOrientation">
      <span class="type-signature">&lt;readonly> </span>screenOrientation<span class="type-signature"> : string</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The <em>last known</em> orientation of the screen, as defined in the Window Screen Web API.
See <a href="Phaser.DOM.html#.getScreenOrientation">Phaser.DOM.getScreenOrientation</a> for possible values.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">string</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L334" title="screenOrientation on line 334 of src/core/ScaleManager.js">src/core/ScaleManager.js line 334</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="sourceAspectRatio" data-name="sourceAspectRatio">
      <span class="type-signature">&lt;readonly> </span>sourceAspectRatio<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The aspect ratio of the original game dimensions.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L379" title="sourceAspectRatio on line 379 of src/core/ScaleManager.js">src/core/ScaleManager.js line 379</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="trackParentInterval" data-name="trackParentInterval">
      <span class="type-signature">&lt;protected> </span>trackParentInterval<span class="type-signature"> : integer</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The maximum time (in ms) between dimension update checks for the Canvas's parent element (or window).
Update checks normally happen quicker in response to other events.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">integer</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>2000</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L496" title="trackParentInterval on line 496 of src/core/ScaleManager.js">src/core/ScaleManager.js line 496</a>
    

	

	
	<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
	<dd class="tag-see">
		<ul>
			<li><a href="Phaser.ScaleManager.html#refresh">refresh</a></li>
			</ul>
	</dd>
	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="width" data-name="width">
      <span class="type-signature">&lt;readonly> </span>width<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Target width (in pixels) of the Display canvas.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L99" title="width on line 99 of src/core/ScaleManager.js">src/core/ScaleManager.js line 99</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="windowConstraints" data-name="windowConstraints">
      <span class="type-signature"></span>windowConstraints<span class="type-signature"></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The edges on which to constrain the game Display/canvas in <em>addition</em> to the restrictions of the parent container.</p>
<p>The properties are strings and can be '', 'visual', 'layout', or 'layout-soft'.</p>
<ul>
<li>If 'visual', the edge will be constrained to the Window / displayed screen area</li>
<li>If 'layout', the edge will be constrained to the CSS Layout bounds</li>
<li>An invalid value is treated as 'visual'</li>
</ul>
    </div>
    

    

    
<dl class="details">
    

    <h5 class="subsection-title">Properties:</h5>

    <dl>

<table class="props table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>bottom</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>



            
            </td>

            

            

            <td class="description prop-description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>right</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>



            
            </td>

            

            

            <td class="description prop-description last"></td>
        </tr>

    
    </tbody>
</table>
</dl>

    

	

	

	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>{"right":"layout","bottom":""}</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L402" title="windowConstraints on line 402 of src/core/ScaleManager.js">src/core/ScaleManager.js line 402</a>
    

	

	

	
</dl>


    
</dd>

        </dl>
    

    
        <h3 class="subsection-title">Methods</h3>

        <dl>
            
<dt>
    <h4 class="name" id="align" data-name="align">
      <span class="type-signature"></span>align( [horizontal] [, vertical])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Shorthand for setting <a href="Phaser.ScaleManager.html#pageAlignHorizontally">pageAlignHorizontally</a> and <a href="Phaser.ScaleManager.html#pageAlignVertically">pageAlignVertically</a>.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>horizontal</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>Value for #pageAlignHorizontally. Pass <code>null</code> to leave unchanged.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>vertical</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>Value for #pageAlignVertically. Omit or pass <code>null</code> to leave unchanged.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L1564" title="align on line 1564 of src/core/ScaleManager.js">src/core/ScaleManager.js line 1564</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="boot" data-name="boot">
      <span class="type-signature">&lt;protected> </span>boot()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Start the ScaleManager.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L686" title="boot on line 686 of src/core/ScaleManager.js">src/core/ScaleManager.js line 686</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="createFullScreenTarget" data-name="createFullScreenTarget">
      <span class="type-signature">&lt;protected> </span>createFullScreenTarget()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Creates a fullscreen target. This is called automatically as as needed when entering
fullscreen mode and the resulting element is supplied to <a href="Phaser.ScaleManager.html#onFullScreenInit">onFullScreenInit</a>.</p>
<p>Use <a href="Phaser.ScaleManager.html#onFullScreenInit">onFullScreenInit</a> to customize the created object.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L1857" title="createFullScreenTarget on line 1857 of src/core/ScaleManager.js">src/core/ScaleManager.js line 1857</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="destroy" data-name="destroy">
      <span class="type-signature">&lt;protected> </span>destroy()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Destroys the ScaleManager and removes any event listeners.
This should probably only be called when the game is destroyed.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L2204" title="destroy on line 2204 of src/core/ScaleManager.js">src/core/ScaleManager.js line 2204</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="forceOrientation" data-name="forceOrientation">
      <span class="type-signature"></span>forceOrientation(forceLandscape [, forcePortrait])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Force the game to run in only one orientation.</p>
<p>This enables generation of incorrect orientation signals and affects resizing but does not otherwise rotate or lock the orientation.</p>
<p>Orientation checks are performed via the Screen Orientation API, if available in browser. This means it will check your monitor
orientation on desktop, or your device orientation on mobile, rather than comparing actual game dimensions. If you need to check the
viewport dimensions instead and bypass the Screen Orientation API then set: <code>ScaleManager.compatibility.orientationFallback = 'viewport'</code></p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>forceLandscape</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>true if the game should run in landscape mode only.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>forcePortrait</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description param-description last"><p>true if the game should run in portrait mode only.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L1246" title="forceOrientation on line 1246 of src/core/ScaleManager.js">src/core/ScaleManager.js line 1246</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="getParentBounds" data-name="getParentBounds">
      <span class="type-signature">&lt;protected> </span>getParentBounds( [target] [, parent])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Returns the computed Parent size/bounds that the Display canvas is allowed/expected to fill.</p>
<p>If in fullscreen mode or without parent (see <a href="Phaser.ScaleManager.html#parentIsWindow">parentIsWindow</a>),
this will be the bounds of the visual viewport itself.</p>
<p>This function takes the <a href="Phaser.ScaleManager.html#windowConstraints">windowConstraints</a> into consideration - if the parent is partially outside
the viewport then this function may return a smaller than expected size.</p>
<p>Values are rounded to the nearest pixel.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>target</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    (new Rectangle)
                
                </td>
            

            <td class="description param-description last"><p>The rectangle to update; a new one is created as needed.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>parent</code></td>
            

            <td class="type">
            
                
<span class="param-type">HTMLElement</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>Ignore #boundingParent and use this node instead.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L1503" title="getParentBounds on line 1503 of src/core/ScaleManager.js">src/core/ScaleManager.js line 1503</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The established parent bounds.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="parseConfig" data-name="parseConfig">
      <span class="type-signature">&lt;protected> </span>parseConfig(config)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Load configuration settings.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>config</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The game configuration object.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L794" title="parseConfig on line 794 of src/core/ScaleManager.js">src/core/ScaleManager.js line 794</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="preUpdate" data-name="preUpdate">
      <span class="type-signature">&lt;protected> </span>preUpdate()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>The ScaleManager.preUpdate is called automatically by the core Game loop.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L1107" title="preUpdate on line 1107 of src/core/ScaleManager.js">src/core/ScaleManager.js line 1107</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="refresh" data-name="refresh">
      <span class="type-signature"></span>refresh()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>The &quot;refresh&quot; methods informs the ScaleManager that a layout refresh is required.</p>
<p>The ScaleManager automatically queues a layout refresh (eg. updates the Game size or Display canvas layout)
when the browser is resized, the orientation changes, or when there is a detected change
of the Parent size. Refreshing is also done automatically when public properties,
such as <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a>, are updated or state-changing methods are invoked.</p>
<p>The &quot;refresh&quot; method <em>may</em> need to be used in a few (rare) situtations when</p>
<ul>
<li>a device change event is not correctly detected; or</li>
<li>the Parent size changes (and an immediate reflow is desired); or</li>
<li>the ScaleManager state is updated by non-standard means; or</li>
<li>certain <a href="Phaser.ScaleManager.html#compatibility">compatibility</a> properties are manually changed.</li>
</ul>
<p>The queued layout refresh is not immediate but will run promptly in an upcoming <code>preRender</code>.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L1396" title="refresh on line 1396 of src/core/ScaleManager.js">src/core/ScaleManager.js line 1396</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="scaleSprite" data-name="scaleSprite">
      <span class="type-signature">&lt;protected> </span>scaleSprite(sprite [, width] [, height] [, letterBox])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Takes a Sprite or Image object and scales it to fit the given dimensions.
Scaling happens proportionally without distortion to the sprites texture.
The letterBox parameter controls if scaling will produce a letter-box effect or zoom the
sprite until it fills the given values. Note that with letterBox set to false the scaled sprite may spill out over either
the horizontal or vertical sides of the target dimensions. If you wish to stop this you can crop the Sprite.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sprite</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|

<span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The sprite we want to scale.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The target width that we want to fit the sprite in to. If not given it defaults to ScaleManager.width.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The target height that we want to fit the sprite in to. If not given it defaults to ScaleManager.height.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>letterBox</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description param-description last"><p>True if we want the <code>fitted</code> mode. Otherwise, the function uses the <code>zoom</code> mode.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L2133" title="scaleSprite on line 2133 of src/core/ScaleManager.js">src/core/ScaleManager.js line 2133</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The scaled sprite.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|

<span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="setGameSize" data-name="setGameSize">
      <span class="type-signature"></span>setGameSize(width, height)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Set the actual Game size.
Use this instead of directly changing <code>game.width</code> or <code>game.height</code>.</p>
<p>The actual physical display (Canvas element size) depends on various settings including</p>
<ul>
<li>Scale mode</li>
<li>Scaling factor</li>
<li>Size of Canvas's parent element or CSS rules such as min-height/max-height;</li>
<li>The size of the Window</li>
</ul>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            

            

            <td class="description param-description last"><p><em>Game width</em>, in pixels.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            

            

            <td class="description param-description last"><p><em>Game height</em>, in pixels.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L938" title="setGameSize on line 938 of src/core/ScaleManager.js">src/core/ScaleManager.js line 938</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="setMinMax" data-name="setMinMax">
      <span class="type-signature"></span>setMinMax(minWidth, minHeight [, maxWidth] [, maxHeight])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Set the min and max dimensions for the Display canvas.</p>
<p><em>Note:</em> The min/max dimensions are only applied in some cases</p>
<ul>
<li>When the device is not in an incorrect orientation; or</li>
<li>The scale mode is EXACT_FIT when not in fullscreen</li>
</ul>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>minWidth</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>The minimum width the game is allowed to scale down to.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minHeight</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>The minimum height the game is allowed to scale down to.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxWidth</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>The maximum width the game is allowed to scale up to; only changed if specified.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxHeight</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>The maximum height the game is allowed to scale up to; only changed if specified.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L1074" title="setMinMax on line 1074 of src/core/ScaleManager.js">src/core/ScaleManager.js line 1074</a>
    

	

	

	
	<dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
	<dd class="tag-todo">
		<ul>
			<li>These values are only sometimes honored.</li>
			</ul>
	</dd>
	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="setResizeCallback" data-name="setResizeCallback">
      <span class="type-signature"></span>setResizeCallback(callback, context)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Sets the callback that will be invoked before sizing calculations.</p>
<p>Typically this is triggered when the Scale Manager has detected a change to the canvas's boundaries:
the browser window has been resized, the device has been rotated, or the parent container's size has changed.
At this point the Scale Manager has not resized the game or canvas yet (and may not resize them at all
after it makes its sizing calculations). You can read the size of the parent container from the
<code>parentBounds</code> argument to the callback.</p>
<p>This is the appropriate place to call <a href="Phaser.ScaleManager.html#setUserScale">setUserScale</a> if needing custom dynamic scaling.</p>
<p>The callback is supplied with two arguments <code>scale</code> and <code>parentBounds</code> where <code>scale</code> is the ScaleManager
and <code>parentBounds</code>, a Phaser.Rectangle, is the size of the Parent element.</p>
<p>This callback</p>
<ul>
<li>May be invoked even though the parent container or canvas sizes have not changed</li>
<li>Unlike <a href="Phaser.ScaleManager.html#onSizeChange">onSizeChange</a>, it runs <em>before</em> the canvas is guaranteed to be updated</li>
<li>Will be invoked from <code>preUpdate</code>, <em>even when</em> the game is paused</li>
</ul>
<p>See <a href="Phaser.ScaleManager.html#onSizeChange">onSizeChange</a> for a better way of reacting to layout updates.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The callback that will be called each time a window.resize event happens or if set, the parent container resizes.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The context in which the callback will be called.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L1001" title="setResizeCallback on line 1001 of src/core/ScaleManager.js">src/core/ScaleManager.js line 1001</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="setupScale" data-name="setupScale">
      <span class="type-signature">&lt;protected> </span>setupScale(width, height)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Calculates and sets the game dimensions based on the given width and height.</p>
<p>This should <em>not</em> be called when in fullscreen mode.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>
|

<span class="param-type">string</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The width of the game.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>
|

<span class="param-type">string</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The height of the game.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L836" title="setupScale on line 836 of src/core/ScaleManager.js">src/core/ScaleManager.js line 836</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="setUserScale" data-name="setUserScale">
      <span class="type-signature"></span>setUserScale(hScale, vScale [, hTrim] [, vTrim] [, queueUpdate] [, force])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Set a User scaling factor used in the USER_SCALE scaling mode.</p>
<p>The target canvas size is computed by:</p>
<pre class="prettyprint source"><code>canvas.width = (game.width * hScale) - hTrim
canvas.height = (game.height * vScale) - vTrim</code></pre><p>This method can be used in the <a href="Phaser.ScaleManager.html#setResizeCallback">resize callback</a>. Set <code>queueUpdate</code> and <code>force</code> to false if the resize callback is being called repeatedly.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>hScale</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>Horizontal scaling factor.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>vScale</code></td>
            

            <td class="type">
            
                
<span class="param-type">numer</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>Vertical scaling factor.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>hTrim</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description param-description last"><p>Horizontal trim, applied after scaling.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>vTrim</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description param-description last"><p>Vertical trim, applied after scaling.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>queueUpdate</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description param-description last"><p>Queue a size/bounds check at next preUpdate</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>force</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description param-description last"><p>Force a resize during the next preUpdate</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L967" title="setUserScale on line 967 of src/core/ScaleManager.js">src/core/ScaleManager.js line 967</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="startFullScreen" data-name="startFullScreen">
      <span class="type-signature"></span>startFullScreen( [antialias] [, allowTrampoline])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Display the game in the browser's fullscreen mode.</p>
<p>This <em>must</em> be called from a user-input Pointer or Mouse event (and possibly a <a href="https://www.chromestatus.com/feature/6131337345892352">"user gesture"</a>), e.g.,</p>
<ul>
<li><a href="Phaser.Events.html#onInputUp">Phaser.Events#onInputUp</a></li>
<li><a href="Phaser.Input.html#onUp">Phaser.Input#onUp</a> or <a href="Phaser.Input.html#onTap">Phaser.Input#onTap</a></li>
<li><code>click</code>, <code>mousedown</code>, <code>mouseup</code>, <code>pointerup</code>, or <code>touchend</code></li>
</ul>
<p>Games within an iframe will also be blocked from fullscreen unless the iframe has the <code>allowfullscreen</code> attribute.</p>
<p>The <a href="https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API">Fullscreen API</a> must be <a href="http://caniuse.com/#search=fullscreen">supported by the browser</a> for this to work - it is not the same as setting
the game size to fill the browser window. See <a href="Phaser.ScaleManager.html#compatibility">compatibility.supportsFullScreen</a> to check if the current
device is reported to support fullscreen mode.</p>
<p>The fullScreenFailed signal will be dispatched if the fullscreen change request failed or the game does not support the Fullscreen API.</p>
<p>Safari blocks access to keyboard events in fullscreen mode (as a security measure).</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>antialias</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>Changes the anti-alias feature of the canvas before jumping in to fullscreen (false = retain pixel art, true = smooth art). If not specified then no change is made. Only works in CANVAS mode.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>allowTrampoline</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>Internal argument. If <code>false</code> click trampolining is suppressed.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L1879" title="startFullScreen on line 1879 of src/core/ScaleManager.js">src/core/ScaleManager.js line 1879</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>Returns true if the device supports fullscreen mode and fullscreen mode was attempted to be started. (It might not actually start, wait for the signals.)</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="stopFullScreen" data-name="stopFullScreen">
      <span class="type-signature"></span>stopFullScreen()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Stops / exits fullscreen mode, if active.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.11.0/src/core/ScaleManager.js#L1982" title="stopFullScreen on line 1982 of src/core/ScaleManager.js">src/core/ScaleManager.js line 1982</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>Returns true if the browser supports fullscreen mode and fullscreen mode will be exited.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>



    </dd>
</dl>


        

    
</dd>

        </dl>
    

    

    
</article>

</section>



</div>
	    <footer class="footer">


<p class="package-signature">
  phaser-ce@2.11.0
  is on
  <a href="https://github.com/photonstorm/phaser-ce/releases/tag/v2.11.0">GitHub</a>
  and
  <a href="https://www.npmjs.com/package/phaser-ce">NPM</a>
</p>





	<p class="copyright">
	Phaser Copyright © 2012-2016 Photon Storm Ltd.
	</p>


<p class="jsdoc-message">
	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a>
	
		on 2018-06-26
	
	using <a href="https://github.com/photonstorm/phaser-ce/tree/master/resources/docstrap-master">Tomorrow</a>.
</p>

</footer>

		</div>
    
      <div class="toc-container hidden-xs hidden-sm">
  <div class="toc-filter">
    <div class="form-inline">
    <div class="form-group">
      <label for="filter" class="control-label">Filter</label>
      <input type="text" class="form-control" id="toc-filter-input">
    </div>
  </div>
  </div>
  <div id="toc">
    <div class="list-group">
      <div id="toc-insert"></div>
    </div>
  </div>
</div>

    
	</div>
</div>

<script defer src="scripts/bundle.js?2018062611"></script>



</body>
</html>